Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

to-choices

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

to-choices

Easily create a normalized inquirer choices question. Supports all of the `choices` question types: checkbox, list, rawlist, expand

  • 0.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
25K
decreased by-12.5%
Maintainers
1
Weekly downloads
 
Created
Source

to-choices NPM version Build Status

Easily create a normalized inquirer choices question. Supports all of the choices question types: checkbox, list, rawlist, expand

Install

Install with npm:

$ npm install to-choices --save

Heads up!

Breaking changes made in v02.0!

The main export now returns a function that takes an options object and, when called, returns the toChoices function to be usef for creating the question object.

Usage

var toChoices = require('to-choices')([options]);

var question = toChoices('foo', ['a', 'b', 'c']);
console.log(question);

The default type is checkbox, so the above code results in:

{ type: 'checkbox',
  name: 'foo',
  message: 'foo',
  choices:
   [ { name: 'all', value: ['a', 'b', 'c'] },
     { type: 'separator', line: '\u001b[90m————\u001b[39m' },
     { name: 'a' },
     { name: 'b' },
     { name: 'c' } ] }

Supported question types

In addition to checkbox, the following types are also supported:

  • expand
  • list
  • rawlist

Signature and all params are the same. Just pass the type to the main export.

Example

Create a list question:

var toQuestions = require('to-choices')({type: 'list'});
var question = toChoices('favorite color?', [
  'red',
  'blue',
  'green'
]);
console.log(question);

Results in:

{ type: 'list',
  choices: [ 'red', 'blue', 'green' ],
  name: 'favorite color',
  message: 'favorite color' }

See the inquirer2 documentation for more details about question objects and supported properties.

  • answer-store: Store answers to user prompts, based on locale and/or current working directory. | homepage
  • question-store: Ask questions, persist the answers. Basic support for i18n and storing answers based on current… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.


This file was generated by verb, v0.9.0, on February 27, 2016.

Keywords

FAQs

Package last updated on 27 Feb 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc